home *** CD-ROM | disk | FTP | other *** search
/ Aminet 7 / Aminet 7 - August 1995.iso / Aminet / dev / misc / Robodoc2_0e.readme < prev    next >
Text File  |  1995-07-02  |  4KB  |  87 lines
  1. Short:    V2.0e Autodocs in HTML/GUIDE
  2. Author:   slothoub@xs4all.nl
  3. Uploader: slothoub@xs4all.nl
  4. Type:     dev/misc
  5.  
  6.  
  7.                           Robodoc 2.0e
  8.                By Maverick Software Development.
  9.  
  10. Robodoc is based on the AutoDocs program written some time ago
  11. by Commodore.  The idea is to include for every function a
  12. standard header containing all sorts of information about that
  13. procedure/function.  An AutoDocs program will extract those
  14. headers from the source file and put them in a autodocs-file.
  15. This way you can include the program documentation in the source
  16. code and is it not necessary to maintain two documents.
  17.  
  18. Robodoc is such a program, however Robodoc has several
  19. additions.  For one it can generate the documentation in
  20. different formats, ASCII, HTML, and AmigaGuide.  Another feature
  21. is that it can fully automatically create links within the
  22. document, and to other documents.  It is also possible to
  23. include parts of the source in you document, complete with
  24. links.  For instance it is possible to include a complete
  25. subroutine, and have the function names in this subroutine point
  26. to their documentation.
  27.  
  28. This is version 2.0e of Robodoc, it has the following features:
  29.   o Code completely rewritten.
  30.   o tab size can be specified.
  31.   o Unlimited number of function headers.
  32.   o Unlimited number of xref entries.
  33.   o More tolerant to different formatted function headers and
  34.     errors.
  35.   o Uses extra amigaguide text attributes (underline and shine).
  36.   o SOURCE item that allows parts of the source code to be
  37.     included in the documentation.
  38.   o New defaults file.
  39.   o Support for Fortran, C, Assembler, LISP, Basic, and many
  40.     other languages you can think of
  41.   o Source code included.
  42.  
  43.                 __  __________
  44.              __/  \/         /    weertj@euronet.nl
  45.           __/  \__/ Maverick
  46.          /  \__/  \ Software
  47.          \__/  \__/ Development
  48.           \______________/        slothoub@xs4all.nl
  49.  
  50. For more information about this and other projects see:
  51.   "http://www.xs4all.nl/~slothoub"
  52.   "http://www.euronet.nl/users/weertj/"
  53.  
  54.  
  55. ============================= Archive contents =============================
  56.  
  57. Original  Packed Ratio    Date     Time    Name
  58. -------- ------- ----- --------- --------  -------------
  59.    24344   13309 45.3% 26-May-95 20:17:02 +Robodoc
  60.     1233     732 40.6% 26-May-95 20:17:02 +Docs.info
  61.    16868    6405 62.0% 26-May-95 20:17:00 +robodoc.doc
  62.     1233     741 39.9% 26-May-95 20:17:02 +Examples.info
  63.     1296     447 65.5% 26-May-95 20:17:00 +prog1.c
  64.     1230     414 66.3% 26-May-95 20:17:00 +prog2.c
  65.    60746   12136 80.0% 26-May-95 20:17:00 +robodoc.c.guide
  66.     1857    1335 28.1% 26-May-95 20:17:00 +robodoc.c.guide.info
  67.     1166     360 69.1% 26-May-95 20:17:00 +robodoc.h.guide
  68.     1857    1335 28.1% 26-May-95 20:17:00 +robodoc.h.guide.info
  69.     1233     730 40.7% 26-May-95 20:17:02 +Headers.info
  70.      439     170 61.2% 26-May-95 20:16:58 +ASSEMBLER.sample
  71.      594     178 70.0% 26-May-95 20:16:58 +BASIC.sample
  72.      475     173 63.5% 26-May-95 20:16:58 +C.sample
  73.      538     179 66.7% 26-May-95 20:16:58 +FORTRAN.sample
  74.      563     181 67.8% 26-May-95 20:16:58 +LISP.sample
  75.     1930     895 53.6% 26-May-95 20:17:02 +Robodoc2.0e.readme
  76.     1233     731 40.7% 26-May-95 20:17:02 +Source.info
  77.       43      38 11.6% 26-May-95 20:17:00 +clean
  78.    60234   13252 77.9% 26-May-95 20:17:00 +robodoc.c
  79.      467     138 70.4% 26-May-95 20:16:58 +robodoc.defaults
  80.       42      34 19.0% 26-May-95 20:16:58 +robodoc.guide.xrefs
  81.      540     217 59.8% 26-May-95 20:17:00 +robodoc.h
  82.       40      34 15.0% 26-May-95 20:16:58 +robodoc.html.xrefs
  83.      169     114 32.5% 26-May-95 20:16:58 +SCOPTIONS
  84.     1583     387 75.5% 26-May-95 20:16:58 +smakefile
  85. -------- ------- ----- --------- --------
  86.   181953   54665 69.9% 29-May-95 10:35:12   26 files
  87.